/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions copyright [year] [name of copyright owner]".
 *
 * Copyright 2015 ForgeRock AS.
 */

package org.forgerock.openam.saml2;

import com.sun.identity.saml2.profile.FederatedSSOException;

import java.io.IOException;

/**
 * An Authenticator is an object used to provide authentication to the session.
 */
public interface SAMLAuthenticator {

    /**
     * Perform authentication tasks.
     *
     * @throws FederatedSSOException If federation authentication was not successful.
     * @throws IOException if the Federation request fails because of communication problems.
     */
    void authenticate() throws FederatedSSOException, IOException;

}
